CxBssEditor Methods

The CxBssEditor object contains the following methods:

Connect
Copy
Delete
Disconnect
DownloadBlob
Edit
New
ReplaceBlob
TouchBlob
View

Connect

The Connect method connects the object to a service.

Syntax

Connect(DomainSiteService As String)

Parameters

Parameter	Required	Description
DomainSiteService	Yes	The [Domain]Site.Service to which to connect. The domain is optional. The service must be a valid one.

Remarks

Returns 0 if successful and a non-zero value if the connection failed.

Example

The following example connects the Client object to the CYGDEMO.<SVC> on domain 5410:

Copy

Connect

1
2
3
4
5
6
7
Sub

    Dim BssEditor
    Set BssEditor = CreateObject("CxEditors.CxBssEditor")
    BssEditor.Connect("[5410]CYGDEMO.BSS")

End Sub

Copy

The Copy method is used to copy a database queue key.

Syntax

Copy(ByVal QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to copy.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified dialog box for record "0000012345":

Copy

Delete

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.Copy("0000012345")
 
    MsgBox iRet
    
End Sub

Delete

The Delete method launches a Delete Entry dialog box for the specified record.

Syntax

Delete(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to delete.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified Delete dialog box for record "0000012345":

Copy

Delete

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.Delete("0000012345")
 
    MsgBox iRet
    
End Sub

Disconnect

The Disconnect method disconnects from the connected service.

Syntax

Disconnect() As Integer

Remarks

The Disconnect method returns 0 if successful and a non-zero value if the disconnect failed.

Example

The following example disconnects the Client object from the connected service, and pops a message box if it is unsuccessful:

Copy

Disconnect

1
2
3
4
5
6
7
8
9
10
11
Sub Svc.Disconnect()
 
    <SvcClient>.Disconnect()
    MsgBox "Service has disconnected."
    
    If <SvcClient>.Disconnect <> 0 
    Then
        MsgBox "Failed to disconnect."
    End If

End Sub

DownloadBlob

The DownloadBlob method prompts the user to download the specified Blob to a selected folder.

Syntax

DownloadBlob(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to download.

Remarks

This method returns a 1 if the file was successfully downloaded, otherwise it returns a 0.

Example

The following example prompts the user to download the Blob with queue key "0000012345."

Copy

DownloadBlob

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet = BssEditor.DownloadBlob("0000012345")
    MsgBox iRet

End Sub

Edit

The Edit method launches an editor dialog box initialized with the information in the specified record.

Syntax

Edit(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to edit.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches an editor dialog box for the record "0000012345":

Copy

Edit

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    
    iRet = <SvcEditor>.Edit("0000012345")
     MsgBox iRet
    
End Sub

New

The New method launches a Select Blob Blob dialog box that is used to upload files to a Blob folder.

Syntax

New() As Integer

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified editor dialog box:

Copy

New

1
2
3
4
5
6
7
8
Sub

    Dim iRet
    iRet = <SvcEditor>.New
 
    MsgBox iRet
    
End Sub

ReplaceBlob

The ReplaceBlob method prompts the user to replace the specified Blob with a selected file of the same name.

Syntax

ReplaceBlob(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to replace.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	The Blob was successfully replaced.
	2	Cancel button was pressed.

Note that it is only possible to replace a Blob with a file of the same name using this method.

Example

The following example prompts the user to replace the Blob with queue key "0000012345."

Copy

ReplaceBlob

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet = BssEditor.ReplaceBlob("0000012345")
    MsgBox iRet

End Sub

TouchBlob

The TouchBlob method updates the file time for the specified Blob.

Syntax

TouchBlob(QueueKey As String) As Integer

Parameters

Parameter	Required	Description
QueueKey	Yes	The database queue key of the record to touch.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	The Blob file time was successfully updated.

Note that it is only possible to replace a Blob with a file of the same name using this method.

Example

The following example prompts the user to touch the Blob with queue key "0000012345."

Copy

TouchBlob

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet = BssEditor.TouchBlob("0000012345")
    MsgBox iRet

End Sub

View

The View method launches a DBS Properties dialog box for the specified database key, that is used to view record details.

Syntax

View(Key As String, EditEnabled As Boolean) As Integer

Parameters

Parameter	Required	Description
Key	Yes	The database key (DbKey) of the record to view/edit.
EditEnabled	Yes	Set this parameter to true to enable editing of a record.

Remarks

This method returns one of the following values:

	-1 or 0	An error occurred.
	1	OK button was pressed.
	2	Cancel button was pressed.

Example

The following example launches the specified editor dialog box for the record "0000012345":

Copy

View

1
2
3
4
5
6
7
Sub

    Dim iRet
    iRet = <SvcEditor>.View("0000012345", True)
    MsgBox iRet

End Sub